core/androidx.core.view/[main]NestedScrollingChild

NestedScrollingChild

This interface should be implemented by View subclasses that wish to support dispatching nested scrolling operations to a cooperating parent ViewGroup.

Classes implementing this interface should create a final instance of a NestedScrollingChildHelper as a field and delegate any View methods to the NestedScrollingChildHelper methods of the same signature.

Views invoking nested scrolling functionality should always do so from the relevant ViewCompat, ViewGroupCompat or ViewParentCompat compatibility shim static methods. This ensures interoperability with nested scrolling views on Android 5.0 Lollipop and newer.

Inheritors

NestedScrollingChild2

NestedScrollingChildImpl

Functions

dispatchNestedFling

abstract fun dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean): Boolean

Dispatch a fling to a nested scrolling parent.

dispatchNestedPreFling

abstract fun dispatchNestedPreFling(velocityX: Float, velocityY: Float): Boolean

Dispatch a fling to a nested scrolling parent before it is processed by this view.

dispatchNestedPreScroll

abstract fun dispatchNestedPreScroll(dx: Int, dy: Int, @Nullable consumed: Array<Int>, @Nullable offsetInWindow: Array<Int>): Boolean

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.

dispatchNestedScroll

abstract fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, @Nullable offsetInWindow: Array<Int>): Boolean

Dispatch one step of a nested scroll in progress.

hasNestedScrollingParent

abstract fun hasNestedScrollingParent(): Boolean

Returns true if this view has a nested scrolling parent.

isNestedScrollingEnabled

abstract fun isNestedScrollingEnabled(): Boolean

Returns true if nested scrolling is enabled for this view.

setNestedScrollingEnabled

abstract fun setNestedScrollingEnabled(enabled: Boolean)

Enable or disable nested scrolling for this view.

startNestedScroll

abstract fun startNestedScroll(axes: Int): Boolean

Begin a nestable scroll operation along the given axes.

stopNestedScroll

abstract fun stopNestedScroll()

Stop a nested scroll in progress.